home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 005 / formgen.arc / FORMGEN.DOC next >
Encoding:
Text File  |  1986-06-13  |  12.4 KB  |  331 lines

  1.  
  2.  
  3.     ---------------------------------------------------------------------
  4.                            FORMGEN VERSION 1.2
  5.     ---------------------------------------------------------------------
  6.  
  7.  
  8.     FORMGEN is a "Mail-Merge" type program intended to be used in
  9.     conjunction with PC-FILE III (or earlier versions).  It interfaces
  10.     with PC-FILE to produce letters with data from your PC-FILE data-
  11.     bases inserted within the body of your letter.
  12.  
  13.   *************************************************************************
  14.   If you find this program of use, a $20 contribution would be appreciated.
  15.   *************************************************************************
  16.  
  17.                           William HT Bailey.
  18.                           P.O. Box 29723
  19.                           Elkins Park, PA
  20.                           19117-0923
  21.  
  22.     This version of the documentation was written 2/26/85 by:
  23.  
  24.          Bill Peacock
  25.          Bakersfield, CA 93309
  26.  
  27.  
  28.     CONFIGURING THE PROGRAM:
  29.  
  30.          You can control the screen colors and type of printer that you are
  31.     using, if a file named FORMGSET.FRM is present when you startup FORMGEN.
  32.     A sample FORMGSET.FRM file might look like this:
  33.  
  34.                              7,0
  35.                              27,69
  36.                              27,70
  37.  
  38.          If the program finds FORMGSET.FRM on the default drive upon
  39.     startup, then it will read the screens foreground and background colors
  40.     from line 1.  In the sample, the 7 specifies a foreground color of
  41.     white and the 0 specifies a background color of black.  Lines 2 and 3
  42.     are optional.  Line 2 contains the ASCII codes of the string the
  43.     program will send to the printer before printing.  Line 3 contains
  44.     the ASCII codes of the string the program will send to the printer
  45.     after printing to turn the printing mode off.  In the sample, the 27
  46.     and 69 represents the characters "ESC" and "E".  This string sets the
  47.     emphasized mode on EPSON or EPSON code compatible printers.  The 27
  48.     and 70 on line 3 represents the characters "ESC" and "F".  This string
  49.     turns off the emphasized mode on EPSON code printers.  The entries on
  50.     each line must be separated by commas.  This file allows you to set
  51.     the configuration codes for your monitor and printer with a simple
  52.     file that you can create with "COPY CON" , with your word processor or
  53.     with FORMGEN itself.
  54.  
  55.  
  56.     SUGGESTION:
  57.  
  58.          Because FORMGEN is a fairly small file, I would suggest that
  59.     you copy the FORMGEN.EXE and the FORMGSET.FRM files to your PC-FILE
  60.     program disk.
  61.  
  62.  
  63.  
  64.                                   - 1 -
  65.  
  66. -
  67.  
  68.                                                                           (2)
  69.  
  70.  
  71.     RUNNING THE PROGRAM:
  72.  
  73.          After loading the program, the main menu looks like this:
  74.  
  75.                         0. EXIT
  76.                         1. CREATE/EDIT A FORM
  77.                         2. OUTPUT A FORM
  78.  
  79.          After you see the Main Menu, choose "CREATE/EDIT" (1.) and the
  80.     program will prompt you with "Which drive has the data? (A,B,C,D):"
  81.     The program requires that the FORMGEN forms (.FRM extensions) AND the
  82.     PC-FILE data-base files both be on the same drive (or sub directory.)
  83.  
  84.          Answer the drive question and you will be shown the names of the
  85.     data-bases on the drive specified under the message "*** DATA FILE".
  86.     Enter the name of the data-base you wish to work with.  The program
  87.     will then ask which FORMGEN form file you wish to work with under the
  88.     message "*** FORM FILE" (no extension req.).  If you haven't created
  89.     a form yet, hit the enter key and you will get the following.
  90.  
  91.        Ins,Mod,Del,List,Store,Quit, Headers or ? (I,M,D,L,S,Q,H,?)
  92.  
  93.        A more understandable definition of the commands follows:
  94.  
  95.          I - (insert) --- Used to insert lines.
  96.          M - (modify) --- Used to alter line.
  97.          D - (delete) --- Used to delete or remove lines.
  98.          L - (list) ----- Screens 20 lines of the form.
  99.          S - (store) ---- Save file to drive you specified at startup.
  100.          Q - (quit) ----- Returns you to main menu.
  101.          H - (headers) -- Shows the fields and the order of the
  102.                           data-base you loaded at startup.
  103.          ? - (question) - Will display 3 screens of instructions.
  104.  
  105.          Type "H" and press "Enter" and you will get a screen of the
  106.     relative number, name and length of the fields that make up the
  107.     data base you called up.  Jot these down on a piece of paper (or
  108.     hit upper case/PrtSc and print it) so that you can refer to them
  109.     as you create the form.  Otherwise you can execute this "H" option,
  110.     as needed, when you are creating the form.
  111.  
  112.          After you have made your notes, type "M" and press "ENTER".
  113.     The next prompt will be "Line Number:".  I would assume that
  114.     you wish to start a new form at line 1, so type "1" and press
  115.     "Enter".  This option allows you to modify the initially blank
  116.     lines in the form with the contents of your form. You can exit
  117.     the modify mode, at the end of your form or to correct an error on a
  118.     previous line or to review the headers, by pressing the ESC key.
  119.  
  120.          You will now see " 1> " which is telling you that you can
  121.     begin typing your form at line number 1.  If you don't want any
  122.     data on the line, just press "Enter".  Note the reverse video box
  123.     in the lower right hand corner of the screen.  This little beauty
  124.     tells you which vertical space you are in and is a very good guide
  125.     as to the margins.        (continued)
  126.  
  127.  
  128.  
  129.  
  130.                                   - 2 -
  131.  
  132. -
  133.  
  134.  
  135.                                                                           (3)
  136.  
  137.          If your form is less than 66 lines long, enter a "\" in the
  138.     first column of the last line after your last line.
  139.  
  140.          The Insert (Ins), Delete (Del), Home, End and Destructive
  141.     Backspace (<-) keys are all active.
  142.  
  143.  
  144.     INSERTING DATA FROM YOUR DATA-BASE IN THE FORM:
  145.  
  146.          To insert data from your PC-FILE data disk, all you have to
  147.     do is enter "|" (upper case left hand back slash key) followed by
  148.     the number of the field that you desire to be printed and then "\".
  149.  
  150.                                EXAMPLE: |1\
  151.  
  152.          After you have typed this in, the program will show you
  153.     the length of the field.
  154.  
  155.                                EXAMPLE:  |1\~~~~~~~~~~~
  156.  
  157.          If you are using the information in a structured form, this is
  158.     sufficient. If you are inserting the data in a form letter however,
  159.     this command will generate the number of spaces that the data-base uses
  160.     and will create blank spaces in the line.  To prevent this from
  161.     happening, enter the call-up command with a minus sign (-) before the
  162.     field number.
  163.  
  164.                                EXAMPLE: |-1\
  165.  
  166.     ----------------------------------------------------------------------
  167.          An example of the CREATE/EDIT screen follows:
  168.  
  169.      1>
  170.      2>
  171.      3>  |1\~~~~~~~~~~~~~~~~~                 (NAME field)
  172.      4>  |2\~~~~~~~~~~~~~~~~~~~~~~~           (ADDRESS  field)
  173.      5>  |-3\~~~~~~~~~~~~~~, |-4\~~~~~ |5\~~~~  (CITY, ST, ZIP fields)
  174.      6>
  175.      7>
  176.      8>  Dear |1\~~~~~~~~~~~~~                (NAME field inserted)
  177.      9>
  178.     10>       Once in a while a rare opportunity to make your hard
  179.     11>  earned dollars work for you comes along. We feel that
  180.     12>  this rare chance has come to |-3\~~~~~~~~~~~~~~~.
  181.     13>
  182.     14>                Yours Truly,
  183.     15>
  184.     16>
  185.     17>                Herman Swartz
  186.     18>                General Manager
  187.     19>
  188.     20>\
  189.  
  190.          Note that the CITY field was inserted at the end of the para-
  191.     graph and the CITY, STATE and ZIP fields were all in one line.
  192.          Remember to put the minus sign before the field number if you
  193.     insert a field in the middle of a line.
  194.  
  195.  
  196.                                   - 3 -
  197.  
  198. -
  199.  
  200.  
  201.                                                                           (4)
  202.          Note that a "\" was placed as the first character in line 20.
  203.     This tells the program that you are finished with the form and
  204.    that you are ready for the command line.  The left hand back slash
  205.    key is just left of the "Z" key below your left little finger.  This
  206.    is very important if your form is less that 66 lines.  If you forget
  207.    this, the program will produce a full 66 line page on output regard-
  208.    less of the number of lines that you specified when you made the
  209.    form in first place.
  210.  
  211.  
  212.     STORING (SAVING) THE FORM:
  213.  
  214.          Now choose the "S" (Store) command and the program will ask
  215.     you for a name for your form.  Name the form using eight or less
  216.     characters and don't worry about an extension.  The program will
  217.     automatically add an extension of "FRM" to the name you gave the
  218.     file and will also store it on the drive you specified at startup.
  219.     When this is done, the program will return you to the Main Menu.
  220.  
  221.  
  222.     EDITING A FORM:
  223.  
  224.          To modify, add, or delete lines in your form, just call it
  225.     up in a similar fashion to how you started.  At the second screen,
  226.     when the program asks "Name of Form" enter the name of the form
  227.     you wish to work on and press "Enter".  You will now get the
  228.     commands line.  Enter "L" (List) and you will be asked for the
  229.     line number.  Enter "1" and the screen will fill with the first
  230.     20 lines of your document starting with line #1.  To correct or
  231.     change, enter "M" (Modify) and you will be asked again for a line
  232.     number.  Screening more than one line at a time allows you to see the
  233.     line in context. If you don't wish to change anything on a line, just
  234.     hit "ENTER". Deleting (D) and Inserting (I) a line (or lines) follows a
  235.     very similar format.
  236.  
  237.          Be very careful when using Insert because it will push anything
  238.     you had on the last line into oblivion.  The best thing to do is to
  239.     use List and review the entire document before attempting to insert
  240.     anything.
  241.  
  242.  
  243.     OUTPUTTING (PRINTING) A FORM:
  244.  
  245.          Following the same methods described earlier, follow the prompts
  246.     until you get to the questions regarding the output.  The program
  247.     will allow you to "Select" for printout in a manner similar to the
  248.     prompts used in PC-FILE except that Formgen repeats the selection pro-
  249.     cedure on each field.  Most of the screen messages in this section
  250.     are easy to follow so you shouldn't have any problems.
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.                                   - 4 -
  263.  
  264. -
  265.  
  266.  
  267.                                                                           (5)
  268.  
  269.     NOTES:
  270.  
  271.     1. Forms created with FORMGEN are ASCII files and can be edited
  272.        with your Word Processor.  Imbedded printer commands work
  273.        properly but be very careful with the "Call-Up" commands created
  274.        when you made the form in the FORMGEN program originally.
  275.  
  276.     2. If one of the data fields that you called up in your form is
  277.        empty, the program will append the blank line at the bottom
  278.        of the page.  This insures forms of uniform length.
  279.  
  280.     3. If you need to stop the output for any reason, (ESCAPE key) you
  281.        can re-start printing without starting all over by using the
  282.        sorting options.
  283.  
  284.     4. If you wish to use a window envelope for your mailing and you
  285.        want the name and address printed on your form to appear in
  286.        the window, you would put the name at line 15, the address at
  287.        line 16 and city-state-zip at line 17.
  288.  
  289.     5. If you wish to call the program up easily, you can create a
  290.        small batch file called "FG.BAT."  The file can easily be
  291.        created from DOS using the "COPY CON:" command.  The step-by-
  292.        step procedure would go like this:
  293.  
  294.        a. At the DOS prompt " A> " prompt, type " COPY CON:FG.BAT"
  295.  
  296.        b. Hit "Enter" and the cursor will move down one line.
  297.  
  298.        c. Type "FORMGEN" and hit "Enter" and the cursor will move down
  299.           one more line.
  300.  
  301.        d. Hit the F6 key (or Control Z) and press "Enter."
  302.  
  303.        e. The screen should display the message "One file copied"
  304.  
  305.        Now to call up the FORMGEN program just type "FG" and press
  306.        "Enter" and the program will load.  Sure beats typing "FORMGEN"
  307.        every time.
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.                                   - 5 -
  329.  
  330. -
  331.